<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html><!-- InstanceBegin template="/Templates/Function Info.dwt" codeOutsideHTMLIsLocked="false" -->
<head>
<!-- InstanceBeginEditable name="doctitle" -->
<title>onLabelEdit (Callback) </title>
<!-- InstanceEndEditable -->
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">

<!-- InstanceBeginEditable name="head" --><!-- InstanceEndEditable -->
<style type="text/css">
<!--
.style3 {font-size: medium}
-->
</style>

<link href="../../WinXStyles.css" rel="stylesheet" type="text/css">
<style type="text/css">
<!--
.style1 {
	font-size: x-large;
	font-family: Verdana, Arial, Helvetica, sans-serif;
}
.style2 {
	font-size: large;
	font-family: Verdana, Arial, Helvetica, sans-serif;
}
-->
</style>
</head>

<body>
<h1 class="style1"><img src="../../WinX48.png" width="48" height="48" align="absmiddle"> <!-- InstanceBeginEditable name="title" -->onLabelEdit (Callback)<!-- InstanceEndEditable --></h1>
<hr>

<!-- InstanceBeginEditable name="Prototype" -->
<p>allow = onLabelEdit (control, code, item, STRING text)</p>
<!-- InstanceEndEditable --><!-- InstanceBeginEditable name="Description" -->
<p>This callback is invoked when the user attempts to edit a label.</p>
<!-- InstanceEndEditable -->
<table width="80%" border="1" cellpadding="0" cellspacing="0">
  <tr bgcolor="#CCCCCC">
    <th width="24%"><span class="style3">Parameter</span></th>
    <th width="76%"><span class="style3">Description</span></th>
  </tr>
  <!-- InstanceBeginRepeat name="Parameter Table" --><!-- InstanceBeginRepeatEntry -->
  <tr bgcolor="#E8E8E8">
    <td><!-- InstanceBeginEditable name="Parameter" -->control<!-- InstanceEndEditable --></td>
    <td><!-- InstanceBeginEditable name="Description" -->The id of the control which generated the event <!-- InstanceEndEditable --></td>
  </tr>
  <!-- InstanceEndRepeatEntry --><!-- InstanceBeginRepeatEntry -->
  <tr bgcolor="#E8E8E8">
    <td><!-- InstanceBeginEditable name="Parameter" -->code<!-- InstanceEndEditable --></td>
    <td><!-- InstanceBeginEditable name="Description" -->A constant which identifies what kind of label editing event occured. See remarks for a list of constants. <!-- InstanceEndEditable --></td>
  </tr>
  <!-- InstanceEndRepeatEntry --><!-- InstanceBeginRepeatEntry -->
  <tr bgcolor="#E8E8E8">
    <td><!-- InstanceBeginEditable name="Parameter" -->item<!-- InstanceEndEditable --></td>
    <td><!-- InstanceBeginEditable name="Description" -->The item the user is attempting to edit the label for <!-- InstanceEndEditable --></td>
  </tr>
  <!-- InstanceEndRepeatEntry --><!-- InstanceBeginRepeatEntry -->
  <tr bgcolor="#E8E8E8">
    <td><!-- InstanceBeginEditable name="Parameter" -->STRING text <!-- InstanceEndEditable --></td>
    <td><!-- InstanceBeginEditable name="Description" -->The new text for the label or the empty string if not applicable<!-- InstanceEndEditable --></td>
  </tr>
  <!-- InstanceEndRepeatEntry --><!-- InstanceEndRepeat -->
</table>
<h3>Returns</h3>
<!-- InstanceBeginEditable name="Return Info" -->
<p>$$TRUE to allow, $$FALSE to cancel </p>
<!-- InstanceEndEditable -->
<h3>Remarks</h3>
<!-- InstanceBeginEditable name="Remarks" -->
<p>This is a callback function. You must supply this function yourself. To register this function, use the <a href="WinXRegOnLabelEdit.htm">WinXRegOnLabelEdit</a> function. </p>
<p>Possible values for the code parameter are:</p>
<dl>
  <dt>$$EDIT_START</dt>
  <dd>The user is attempting to edit a label. Return $$TRUE to allow or $$FALSE to cancel</dd>
  <dt>$$EDIT_DONE</dt>
  <dd>The user has finished editing a label. The text parameter will contain the new label for the control. Return $$TRUE to change the label or $$FALSE to cancel. If the new label is the empty string and you return $$TRUE, the label will not change. </dd>
</dl>
<!-- InstanceEndEditable -->
<h3>Examples</h3>
<table width="80%"  border="0">
  <tr>
    <td bgcolor="#C6C6FF"><!-- InstanceBeginEditable name="Example Code" -->
      <p class="codeStyle">See the tree view demo program in the samples folder</p>
      <!-- InstanceEndEditable --></td>
  </tr>
</table>

<h2 class="style2">Related Links</h2>
<!-- InstanceBeginEditable name="Related Links" -->
<p><a href="WinXRegOnLabelEdit.htm">WinXRegOnLabelEdit</a></p>
<!-- InstanceEndEditable -->
</body>
<!-- InstanceEnd --></html>
